#ifndef _SCHED_H
#define _SCHED_H

#define NR_TASKS 64 // 系统中同事最多任务（进程）数
#define HZ 100      // 定义系统时钟滴答频率（100Hz，每个滴答10ms）

#define FIRST_TASK task[0]  // 任务0比较特殊 所以特意给它单独定义一个符号
#define LAST_TASK task[NR_TASKS-1]  // 任务数组中的最后一项任务

#include <linux/head.h> // head头文件 定义了段描述符的简单结构 和几个选择符常量
#include <linux/fs.h>   // 文件系统头文件 定义文件表结构（file buffer_head m_inode）
#include <linux/mm.h>   // 内存管理头文件 含有页面大小定义和一些页面释放函数原型
#include <signal.h>     // 信号头文件 定义信号符号常量 信号结构以及信号操作函数原型

#if (NR_OPEN > 32)
#error "Currently the close-on-exec-flags are in one word, max 32 files/proc"
#endif
// 这里定义了进程运行可能处的状态
#define TASK_RUNNING		0       // 进程正在运行或已准备就绪
#define TASK_INTERRUPTIBLE	1       // 进程处于可中断等待状态
#define TASK_UNINTERRUPTIBLE	2   // 进程处于不可中断等待状态 主要用于IO操作等待
#define TASK_ZOMBIE		3           // 进程处于僵死状态 已经停止运行 但父进程还没发信号
#define TASK_STOPPED		4       // 进程已停止

#ifndef NULL
#define NULL ((void *) 0)           // 定义NULL为空指针
#endif
// 复制进程的页目录页表 Linus认为这是内核中最复杂的函数之一
extern int copy_page_tables(unsigned long from, unsigned long to, long size);
extern int free_page_tables(unsigned long from, unsigned long size);    // 释放页表所指定的内存块及页表本身

extern void sched_init(void);   // 调度程序的初始化函数
extern void schedule(void);     // 进程调度函数
extern void trap_init(void);    // 异常（陷阱）中断处理初始化函数 设置中断调用门并允许中断请求信号
extern void panic(const char * str);    // 显示内核出错信息 进入死循环
extern int tty_write(unsigned minor,char * buf,int count);  // 往tty上写指定长度的字符串

typedef int (*fn_ptr)();    // 定义函数指针类型
// 下面是数学协处理器使用的结构 主要用于保存进程切换时 i387 的执行状态信息
struct i387_struct {
	long	cwd;    // 控制字
	long	swd;    // 状态字
	long	twd;    // 标记字
	long	fip;    // 协处理器代码指针
	long	fcs;    // 协处理器代码段寄存器
	long	foo;    // 内存操作数的偏移值
	long	fos;    // 内存操作数的段值
	long	st_space[20];	/* 8*10 bytes for each FP-reg = 80 bytes */ // 8个10字节的协处理器累加器
};
// 任务状态段数据结构
struct tss_struct {
	long	back_link;	/* 16 high bits zero */
	long	esp0;
	long	ss0;		/* 16 high bits zero */
	long	esp1;
	long	ss1;		/* 16 high bits zero */
	long	esp2;
	long	ss2;		/* 16 high bits zero */
	long	cr3;
	long	eip;
	long	eflags;
	long	eax,ecx,edx,ebx;
	long	esp;
	long	ebp;
	long	esi;
	long	edi;
	long	es;		/* 16 high bits zero */
	long	cs;		/* 16 high bits zero */
	long	ss;		/* 16 high bits zero */
	long	ds;		/* 16 high bits zero */
	long	fs;		/* 16 high bits zero */
	long	gs;		/* 16 high bits zero */
	long	ldt;		/* 16 high bits zero */
	long	trace_bitmap;	/* bits: trace 0, bitmap 16-31 */
	struct i387_struct i387;
};
// 这里是任务（进程）数据结构 或称为进程描述符
struct task_struct {
/* these are hardcoded - don't touch */
	long state;	/* -1 unrunnable, 0 runnable, >0 stopped */ // 任务的运行状态（-1不可运行 0可运行 >0 已停止）
	long counter;   // 任务运行时间计数（递减）（滴答数） 运行时间片
	long priority;  // 运行优先数 任务开始运行时 counter = priority 越大运行越长
	long signal;    // 信号 是位图 每个比特位代表一种信号 信号值 = 位偏移值+1
	struct sigaction sigaction[32]; // 信号执行属性结构 对应信号将要执行 的操作和标志信息
	long blocked;	/* bitmap of masked signals */  // 进程信号屏蔽码（对应信号位图）
/* various fields */
	int exit_code;  // 任务执行停止的退出码 其父进程会取
	unsigned long start_code,end_code,end_data,brk,start_stack; // start_code-代码段地址 end_code-代码长度（字节数） end_data-代码长度+数据长度（字节数） brk-总长度（字节数）start_stack-堆栈段地址
	long pid,father,pgrp,session,leader;    // pid-进程标识号（进程号） father-父进程号 pgrp-父进程组号 session-会话号 leader-会话首领
	unsigned short uid,euid,suid;   // uid-用户标识号（用户id） euid-有效用户id suid-保存的用户id
	unsigned short gid,egid,sgid;   // gid-组标识号（组id） egid-有效组id sgid-保存的组id
	long alarm; // 报警定时值（滴答数）
	long utime,stime,cutime,cstime,start_time;  // utime-用户态运行时间（滴答数） stime-系统态运行时间（滴答数） cutime-子进程用户态运行时间 cstime-子进程系统态运行时间
	unsigned short used_math;   // 标志 是否使用了协处理器
/* file system info */
	int tty;		/* -1 if no tty, so it must be signed */    // 进程使用tty的子设备号 -1表示没有使用
	unsigned short umask;   // 文件创建属性屏蔽位
	struct m_inode * pwd;   // 当前工作目录i节点结构
	struct m_inode * root;  // 根目录i节点结构
	struct m_inode * executable;    // 执行文件i节点结构
	unsigned long close_on_exec;    // 执行关闭文件句柄位图标志
	struct file * filp[NR_OPEN];    // 进程使用的文件表结构
/* ldt for this task 0 - zero 1 - cs 2 - ds&ss */
	struct desc_struct ldt[3];      // 本任务的局部表描述符 0-空 1-代码段cs 2-数据和堆栈段ds&ss
/* tss for this task */
	struct tss_struct tss;          // 本进程的任务状态段信息结构
};

/*  // INIT_TASK 用于设置第1个任务表 若想修改责任自负 基址=0 段限长=0x9ffff
 *  INIT_TASK is used to set up the first task table, touch at
 * your own risk!. Base=0, limit=0x9ffff (=640kB)
 */ // 对应上面任务结构的第1个任务（任务0） 的数据信息
#define INIT_TASK \
/* state etc */	{ 0,15,15, \
/* signals */	0,{{},},0, \
/* ec,brk... */	0,0,0,0,0,0, \
/* pid etc.. */	0,-1,0,0,0, \
/* uid etc */	0,0,0,0,0,0, \
/* alarm */	0,0,0,0,0,0, \
/* math */	0, \
/* fs info */	-1,0022,NULL,NULL,NULL,0, \
/* filp */	{NULL,}, \
	{ \
		{0,0}, \
/* ldt */	{0x9f,0xc0fa00}, \  // 代码长 640K 基址0x0 G=1 D=1 DPL=3 P=1 TYPE=0x0a
		{0x9f,0xc0f200}, \      // 数据长 640K 基址0x0 G=1 D=1 DPL=3 P=1 Type=0x02
	}, \
/*tss*/	{0,PAGE_SIZE+(long)&init_task,0x10,0,0,0,0,(long)&pg_dir,\
	 0,0,0,0,0,0,0,0, \
	 0,0,0x17,0x17,0x17,0x17,0x17,0x17, \
	 _LDT(0),0x80000000, \
		{} \
	}, \
}

extern struct task_struct *task[NR_TASKS];  // 任务数组
extern struct task_struct *last_task_used_math; // 上一个使用过协处理器的进程
extern struct task_struct *current;         // 当前进程结构指针变量
extern long volatile jiffies;               // 从开机开始算起的滴答数（10ms/滴答）
extern long startup_time;                   // 开机时间 从1970.1.1:0:0:0 开始计时的秒数

#define CURRENT_TIME (startup_time+jiffies/HZ)  // 当前时间（秒数）

extern void add_timer(long jiffies, void (*fn)(void));  // 添加定时器函数（定时时间jiffies滴答数 定时到时调用函数*fn）
extern void sleep_on(struct task_struct ** p);  // 不可中断的等待睡眠
extern void interruptible_sleep_on(struct task_struct ** p);    // 可中断的等待睡眠
extern void wake_up(struct task_struct ** p);   // 明确唤醒睡眠的进程

/*  // 寻找第1个TSS在全局表中的入口 0-没有用nul 1-代码段 2-数据段ds 3-系统断syscall 4-任务状态段TSS0 5-局部表LTD0 6-任务状态段TSS1 等
 * Entry into gdt where to find first TSS. 0-nul, 1-cs, 2-ds, 3-syscall
 * 4-TSS0, 5-LDT0, 6-TSS1 etc ...
 */
#define FIRST_TSS_ENTRY 4   // 全局表中第1个局部描述符表（LDT）描述符的选择符索引号
#define FIRST_LDT_ENTRY (FIRST_TSS_ENTRY+1)
#define _TSS(n) ((((unsigned long) n)<<4)+(FIRST_TSS_ENTRY<<3)) // 宏定义 计算在全局表中第n个任务的TSS描述符的索引号（选择符）
#define _LDT(n) ((((unsigned long) n)<<4)+(FIRST_LDT_ENTRY<<3)) // 宏定义 计算在全局表中第n个任务的LDT描述符的索引号
#define ltr(n) __asm__("ltr %%ax"::"a" (_TSS(n)))   // 宏定义 加载第n个任务的任务寄存器tr
#define lldt(n) __asm__("lldt %%ax"::"a" (_LDT(n))) // 宏定义 加载第n个任务的局部描述符表寄存器ldtr
#define str(n) \    // 取当前运行任务的任务号（是任务数组中的索引值 与进程号pid不同）    // 返回：n-当前任务号
__asm__("str %%ax\n\t" \        // 将任务寄存器中TSS段的有效地址==>ax
	"subl %2,%%eax\n\t" \       // (eax-FIRST_TSS_ENTRY*8)==>eax
	"shrl $4,%%eax" \           // （eax/16）==> ax = 当前任务号
	:"=a" (n) \
	:"a" (0),"i" (FIRST_TSS_ENTRY<<3))
/*  switch_to(n) 将切换当前任务到任务nr即n，首先检测任务n不是当前任务 如果是则什么也不做退出 如果我们切换到任务最近（上次运行）使用过数学协处理器的话 则还需复位控制寄存器cr0中的TS标志
 *	switch_to(n) should switch tasks to task nr n, first
 * checking that n isn't the current task, in which case it does nothing.
 * This also clears the TS-flag if the task we switched to has used
 * tha math co-processor latest.
 */ // 输入：%0-新TSS的偏移地址（*&_tmp.a） %1-存放新TSS的选择符值（*&_tmp.b）dx-新任务n的选择符 ecx-新任务指针task【n】
#define switch_to(n) {\ // 其中临时数据结构_tmp中a的值是32为偏移值 b为新TSS的选择符 在任务切换时 a值没有用（忽略）在判断新任务上次执行是否使用过协处理器时，是通过将新任务状态段的地址与保存在 last_task_used_math 变量中的使用过协处理器的任务状态段的地址进行比较而作出的
struct {long a,b;} __tmp; \
__asm__("cmpl %%ecx,_current\n\t" \ // 任务n是当前任务吗
	"je 1f\n\t" \                   // 是 则什么都不做 退出
	"movw %%dx,%1\n\t" \            // 将新任务的选择符 ==> *&_tmp.b
	"xchgl %%ecx,_current\n\t" \    // current=task【n】 ecx=被切换出的任务
	"ljmp %0\n\t" \                 // 执行长跳转至*&_tmp 造成任务切换 在任务切换回来后才会执行下面的语句
	"cmpl %%ecx,_last_task_used_math\n\t" \ // 新任务上次使用过协处理器吗
	"jne 1f\n\t" \  // 没有则跳转 退出
	"clts\n" \      // 新任务上次使用过协处理器 则清cr0的TS标志
	"1:" \
	::"m" (*&__tmp.a),"m" (*&__tmp.b), \
	"d" (_TSS(n)),"c" ((long) task[n])); \
}
// 页面地址对准(在内核代码中没有任务地方引用)
#define PAGE_ALIGN(n) (((n)+0xfff)&0xfffff000)
// 设置位于地址addr处描述符中的基地址字段（基地址是base） 参见列表后说明 %0-地址addr偏移2 %1-地址addr偏移4 %@-地址addr偏移7 edx-基地址base
#define _set_base(addr,base) \
__asm__("movw %%dx,%0\n\t" \    // 基址base低16位（位15-0）-> 【addr+2】
	"rorl $16,%%edx\n\t" \      // edx中基址高16位（位31-16）-dx
	"movb %%dl,%1\n\t" \        // 基址高16位中的低8位（位23-16）-> 【addr+4】
	"movb %%dh,%2" \            // 基址高16位中的高8位（位31-24）-> 【addr+7】
	::"m" (*((addr)+2)), \
	  "m" (*((addr)+4)), \
	  "m" (*((addr)+7)), \
	  "d" (base) \
	:"dx")
// 设置位于地址addr处描述符中的段限长字段（段长是limit）
#define _set_limit(addr,limit) \    // %0-地址add %1-地址addr偏移6处 edx-段长值limit
__asm__("movw %%dx,%0\n\t" \
	"rorl $16,%%edx\n\t" \          // 段长limit低16位（位15-0）->【addr】
	"movb %1,%%dh\n\t" \            // edx中的段长高4位（位19-16）-dl
	"andb $0xf0,%%dh\n\t" \         // 取原【add+6】字节-dh 其中高4位是写标志
	"orb %%dh,%%dl\n\t" \           // 清dh的低4位（将存放段长的位19-16）
	"movb %%dl,%1" \                // 将原高4位标志和段长的高4位（位19-16）合成
	::"m" (*(addr)), \              // 1字节 并放回【addr+6】处
	  "m" (*((addr)+6)), \
	  "d" (limit) \
	:"dx")
// 设置局部描述符表中 ldt 描述符的基地址字段
#define set_base(ldt,base) _set_base( ((char *)&(ldt)) , base )
#define set_limit(ldt,limit) _set_limit( ((char *)&(ldt)) , (limit-1)>>12 ) // 设置局部描述符表中ldt描述符的段长字段
// 从地址addr处描述符中取段基址 功能与set_base相反
#define _get_base(addr) ({\ // edx-存放基址（_base）%1-地址addr偏移2 %2-地址addr偏移4 %3-addr偏移7
unsigned long __base; \
__asm__("movb %3,%%dh\n\t" \    // 取【addr+7】处基址高16位的高8位（位41-24）->dh
	"movb %2,%%dl\n\t" \
	"shll $16,%%edx\n\t" \
	"movw %1,%%dx" \
	:"=d" (__base) \
	:"m" (*((addr)+2)), \
	 "m" (*((addr)+4)), \
	 "m" (*((addr)+7))); \
__base;})
// 取局部描述符表中ldt所指段描述符中的基地址
#define get_base(ldt) _get_base( ((char *)&(ldt)) )
// 取段选择符segment的段长值 %0-存放段长值（字节数）%1-段选择符segment
#define get_limit(segment) ({ \
unsigned long __limit; \
__asm__("lsll %1,%0\n\tincl %0":"=r" (__limit):"r" (segment)); \
__limit;})

#endif
